ccapi.h

Go to the documentation of this file.

/*********************************************************************
 *
 *           Copyright (c) 2021 by Visuality Systems, Ltd.
 *
 *************************************************************************
 * FILE NAME     : $Workfile:$
 * ID            : $Header:$
 * REVISION      : $Revision:$
 *--------------------------------------------------------------------
 * DESCRIPTION   : Client API
 *--------------------------------------------------------------------
 * MODULE        : NQ
 * DEPENDENCIES  :
 *************************************************************************/

#ifndef _CCAPI_H_
#define _CCAPI_H_

#include "syapi.h"
#include "cmapi.h"
#include <amcredentials.h>
#include <ccparams.h>

/* ********************************************************************
 * Constants
 ********************************************************************/

/* *** Credential fields length ****/
#define CM_USERNAMELENGTH   256                     
#define PASSWORD_LENGTH     UD_NQ_MAXPWDLEN         
#define DOMAIN_LENGTH       (CM_NQ_HOSTNAMESIZE)    
/* *** Notification events ****/
#define NOTIFY_SRCH_HANDLE_ERROR    1   
#define NOTIFY_FILE_HANDLE_ERROR    2   
/* *** File attributes ****/
#define CIFS_ATTR_READONLY      0x01 
#define CIFS_ATTR_HIDDEN        0x02 
#define CIFS_ATTR_SYSTEM        0x04 
#define CIFS_ATTR_VOLUME        0x08 
#define CIFS_ATTR_DIR           0x10 
#define CIFS_ATTR_ARCHIVE       0x20 
#define CIFS_ATTR_ALL           (CIFS_ATTR_HIDDEN | CIFS_ATTR_SYSTEM | CIFS_ATTR_DIR)

/* *** File access mode ****/
#define FILE_AM_READ            0   
#define FILE_AM_WRITE           1   
#define FILE_AM_READ_WRITE      2   
#define FILE_AM_SPECIAL_MASK    0x8000000

/* *** File share mode ****/
#define FILE_SM_COMPAT          0   
#define FILE_SM_EXCLUSIVE       1   
#define FILE_SM_DENY_WRITE      2   
#define FILE_SM_DENY_READ       3   
#define FILE_SM_DENY_NONE       4   
/* *** File locality ****/
#define FILE_LCL_UNKNOWN        0   
#define FILE_LCL_SEQUENTIAL     1   
#define FILE_LCL_RANDOM         2   
#define FILE_LCL_MIXED          3   
/* *** File create action ****/
#define FILE_CA_FAIL            0   
#define FILE_CA_CREATE          1   
/* @note: create action can be one of those values not both */

/* *** File open action ****/
#define FILE_OA_FAIL            0   
#define FILE_OA_OPEN            1   
#define FILE_OA_TRUNCATE        2   
/* @note: open action can be one of those values but not a combination */

/* File seek method */
#define SEEK_FILE_BEGIN         0   
#define SEEK_FILE_CURRENT       1   
#define SEEK_FILE_END           2   
/* *** LAN Manager Authentication Level ****/
#define NQ_CC_AUTH_LM_AND_NTLM      1   
#define NQ_CC_AUTH_NTLM             2   
#define NQ_CC_AUTH_NTLM_V2          3   
#if defined(UD_CC_INCLUDEEXTENDEDSECURITY_KERBEROS) || defined(DOXYGEN)
#define NQ_CC_AUTH_SPNEGO_KERBEROS  4   
#endif /* UD_CC_INCLUDEEXTENDEDSECURITY_KERBEROS */

/* User logon type */
#define CC_LOGON_TYPE_REGULAR         0   
#define CC_LOGON_TYPE_ANONYMOUS       1   
#define CC_LOGON_TYPE_GUEST           2   
/* server capabilities */
#define CC_CAPABILITY_DFS                   0x00000001            
#define CC_CAPABILITY_LEASING               0x00000002            
#define CC_CAPABILITY_LARGE_MTU             0x00000004            
#define CC_CAPABILITY_MULTI_CHANNEL         0x00000008            
#define CC_CAPABILITY_PERSISTENT_HANDLES    0x00000010            
#define CC_CAPABILITY_DIRECTORY_LEASING     0x00000020            
#define CC_CAPABILITY_ENCRYPTION            0x00000040            
/* signing policy */
#define CC_SIGNING_ENABLED       0x0001       
#define CC_SIGNING_REQUIRED      0x0002       
typedef enum
{
    CC_SMB100, 
    CC_SMB202, 
    CC_SMB210, 
    CC_SMB300, 
    CC_SMB302, 
    CC_SMB311  
}
CCSmbDialect;

typedef void (* CCServerSideCopyCallback)(NQ_STATUS status, NQ_UINT32 totalBytesWritten, NQ_UINT64 totalFileSize, void* context);

typedef struct {
    NQ_UINT32 timeLow;      
    NQ_UINT32 timeHigh;     
} CCFileTime;

typedef struct CCFindFileDataA{
    NQ_UINT32 fileAttributes;       
    NQ_UINT32 creationTimeLow;      
    NQ_UINT32 creationTimeHigh;     
    NQ_UINT32 lastAccessTimeLow;    
    NQ_UINT32 lastAccessTimeHigh;   
    NQ_UINT32 lastWriteTimeLow;     
    NQ_UINT32 lastWriteTimeHigh;    
    NQ_UINT32 changeTimeLow;        
    NQ_UINT32 changeTimeHigh;       
    NQ_UINT32 fileSizeLow;          
    NQ_UINT32 fileSizeHigh;         
    NQ_UINT32 allocationSizeLow;    
    NQ_UINT32 allocationSizeHigh;   
    NQ_UINT32 fileNameLength;       
    NQ_CHAR fileName[CM_BUFFERLENGTH(NQ_CHAR, UD_FS_FILENAMECOMPONENTLEN)];    
} FindFileDataA_t;

typedef struct {
    NQ_UINT32 fileAttributes;       
    NQ_UINT32 creationTimeLow;      
    NQ_UINT32 creationTimeHigh;     
    NQ_UINT32 lastAccessTimeLow;    
    NQ_UINT32 lastAccessTimeHigh;   
    NQ_UINT32 lastWriteTimeLow;     
    NQ_UINT32 lastWriteTimeHigh;    
    NQ_UINT32 changeTimeLow;        
    NQ_UINT32 changeTimeHigh;       
    NQ_UINT32 fileSizeLow;          
    NQ_UINT32 fileSizeHigh;         
    NQ_UINT32 allocationSizeLow;    
    NQ_UINT32 allocationSizeHigh;   
    NQ_UINT32 fileNameLength;       
    NQ_WCHAR fileName[CM_BUFFERLENGTH(NQ_WCHAR, UD_FS_FILENAMECOMPONENTLEN)];    
} CCFindFileData;

typedef struct CCFileInfo_t{
    NQ_UINT32 creationTimeLow;      
    NQ_UINT32 creationTimeHigh;     
    NQ_UINT32 lastAccessTimeLow;    
    NQ_UINT32 lastAccessTimeHigh;   
    NQ_UINT32 lastWriteTimeLow;     
    NQ_UINT32 lastWriteTimeHigh;    
    NQ_UINT32 attributes;           
    NQ_UINT32 volumeSerialNumber;   
    NQ_UINT32 allocationSizeLow;    
    NQ_UINT32 allocationSizeHigh;   
    NQ_UINT32 fileSizeLow;          
    NQ_UINT32 fileSizeHigh;         
    NQ_UINT32 numberOfLinks;        
    NQ_UINT32 fileIndexLow;         
    NQ_UINT32 fileIndexHigh;        
} FileInfo_t;

typedef struct
{
    NQ_UINT64 creationTime;         
    NQ_UINT64 lastAccessTime;       
    NQ_UINT64 lastWriteTime;        
    NQ_UINT64 changeTime;           
    NQ_UINT64 endOfFile;            
    NQ_UINT64 allocationSize;       
    NQ_UINT32 attributes;           
    NQ_UINT32 numberOfLinks;        
    NQ_UINT64 fileIndex;            
    NQ_UINT64 volumeId;             
} CCFileInfo; /* File information structure. */

typedef struct
{
    NQ_UINT sectorsPerCluster;  /* Number of sectors per cluster. */
    NQ_UINT bytesPerSector;     /* Number of bytes per sector. */
    NQ_UINT64 freeClusters;     /* Number of free clusters. */
    NQ_UINT64 totalClusters;    /* Number of clusters on disk. */
    NQ_UINT fsType;             /* File system type as disk or DC. */
    NQ_UINT serialNumber;       /* Disk serial number. */
} CCVolumeInfo; /* Volume information structure. */

typedef struct
{
    NQ_FLOAT readAmount;    
    NQ_FLOAT writeAmount;   
}CCSStatistics; /* data transferring statistics */

typedef struct
{
    CCSmbDialect  dialect;                    
    NQ_UINT32     serverCapabilities;         
    NQ_IPADDRESS  *ips;                       
    NQ_COUNT      numIps;                     
    NQ_INT        serverSigningPolicy;        
} CCServerInfo; /* server information structure. */

typedef struct
{
    NQ_TIME       creationTime;               
    NQ_INT        userLogonType;              
    NQ_CHAR       *serverName;                
    CCServerInfo  serverInfo;                 
    CCSStatistics statistics;                 
} CCMountInfoA; /* ASCII version of mount information structure. */

typedef struct
{
    NQ_TIME       creationTime;               
    NQ_INT        userLogonType;              
    NQ_WCHAR      *serverName;                
    CCServerInfo  serverInfo;                 
    CCSStatistics statistics;                 
} CCMountInfo; /* Mount information structure. */

typedef struct{
    NQ_CHAR *   name;               
    NQ_UINT32   type;               
    NQ_CHAR *   comment;            
}CCNetShareItemA;

/* CCNetShareItem */
typedef struct{
    NQ_WCHAR *  name;               
    NQ_UINT32   type;               
    NQ_WCHAR *  comment;            
}CCNetShareItem;

/* CCNetServerItem */
typedef struct{
    NQ_WCHAR *  name;               
    NQ_UINT32   type;               
    NQ_WCHAR * comment;             
    NQ_BYTE majorVersion;           
    NQ_BYTE minorVersion;           
}CCNetServerItem;

/* CCNetDomainItem */
typedef struct{
    NQ_WCHAR *  name;               
    NQ_UINT32   type;               
    NQ_WCHAR * comment;             
    NQ_BYTE majorVersion;           
    NQ_BYTE minorVersion;           
}CCNetDomainItem;

/*********************************************************************
 * API functions
 ********************************************************************/

NQ_BOOL ccInit(void (*fsdNotify)(NQ_INT eventId, NQ_ULONG param));

void ccShutdown(void);

NQ_BOOL ccIsInitialized(void);

NQ_INT ccAddMountA(const NQ_CHAR *mountPoint, const NQ_CHAR *remotePath, NQ_BOOL connect);

NQ_INT ccAddMount(const NQ_WCHAR *mountPoint, const NQ_WCHAR *remotePath, NQ_BOOL connect);

NQ_INT ccAddMountWithCredsA(const NQ_CHAR * mountPoint, const NQ_CHAR * remotePath, NQ_BOOL connect, const AMCredentialsA * userCredentials);

NQ_INT ccAddMountWithCreds(const NQ_WCHAR * mountPoint, const NQ_WCHAR * remotePath, NQ_BOOL connect, const AMCredentials * userCredentials);

NQ_INT ccRemoveMountA(const NQ_CHAR *mountPoint);

NQ_INT ccRemoveMount(const NQ_WCHAR *mountPoint);

NQ_GUID ccGetServerIdA(const NQ_CHAR * mountpoint);

NQ_GUID ccGetServerId(const NQ_WCHAR * mountpoint);

NQ_BOOL ccGetMountInformationA(const NQ_CHAR * mountPoint, CCMountInfoA * mountPointInfo);

NQ_BOOL ccGetMountInformation(const NQ_WCHAR * mountPoint, CCMountInfo * mountPointInfo);
NQ_HANDLE ccFindFirstFileA(const NQ_CHAR *srchPath, FindFileDataA_t *findFileData, NQ_BOOL extractFirst);

NQ_HANDLE ccFindFirstFile(const NQ_WCHAR *srchPath, CCFindFileData *findFileData, NQ_BOOL extractFirst);

NQ_BOOL ccFindNextFileA(NQ_HANDLE handle, FindFileDataA_t *findFileData);

NQ_BOOL ccFindNextFile(NQ_HANDLE handle, CCFindFileData *findFileData);

NQ_BOOL ccFindClose(NQ_HANDLE handle);

NQ_BOOL ccCreateDirectoryA(const NQ_CHAR *pathName);

NQ_BOOL ccCreateDirectory(const NQ_WCHAR *pathName);

NQ_BOOL ccRemoveDirectoryA(const NQ_CHAR *pathName);

NQ_BOOL ccRemoveDirectory(const NQ_WCHAR *pathName);

NQ_HANDLE ccCreateFileA(const NQ_CHAR *fileName, NQ_INT access, NQ_INT shareMode,
                        NQ_INT locality, NQ_BOOL writeThrough, NQ_UINT16 attributes,
                        NQ_INT createAction, NQ_INT openAction);

NQ_HANDLE ccCreateFile(const NQ_WCHAR *fileName, NQ_INT access, NQ_INT shareMode,
                        NQ_INT locality, NQ_BOOL writeThrough, NQ_UINT16 attributes,
                        NQ_INT createAction, NQ_INT openAction);

NQ_BOOL ccDeleteFileA(const NQ_CHAR *fileName);

NQ_BOOL ccDeleteFile(const NQ_WCHAR *fileName);

NQ_BOOL ccMoveFileA(const NQ_CHAR *oldFilename, const NQ_CHAR *newFilename);

NQ_BOOL ccMoveFile(const NQ_WCHAR *oldFilename, const NQ_WCHAR *newFilename);

NQ_BOOL ccReadFile(NQ_HANDLE hndl, NQ_IOBufPos buffer, NQ_UINT count, NQ_UINT *readSize);

NQ_BOOL ccReadFileAsync(NQ_HANDLE hndl, NQ_IOBufPos buffer, NQ_UINT count, void * context, void (* callback)(NQ_STATUS, NQ_UINT, void *));

NQ_BOOL ccWriteFile(NQ_HANDLE hndl, NQ_IOBufPos buffer, NQ_UINT count, NQ_UINT *writtenSize);

NQ_BOOL ccWriteFileAsync(NQ_HANDLE hndl, NQ_IOBufPos buffer, NQ_UINT count, void * context, void (* callback)(NQ_STATUS , NQ_UINT, void *));

NQ_BOOL ccFlushFile(NQ_HANDLE handle);

NQ_BOOL ccCloseHandle(NQ_HANDLE handle);

NQ_BOOL ccGetFilePointer(NQ_HANDLE handle, NQ_UINT64 * offset);

NQ_BOOL ccSetFilePointer(NQ_HANDLE handle, NQ_INT64 * offset, NQ_INT method);

NQ_BOOL ccServerSideDataCopyA(NQ_CHAR* srcPath, NQ_CHAR* dstPath, void* context, CCServerSideCopyCallback* callBack);


NQ_BOOL ccServerSideDataCopy(NQ_WCHAR* srcPath, NQ_WCHAR* dstPath, void* context, CCServerSideCopyCallback* callBack);

NQ_BOOL ccGetDiskFreeSpaceA(const NQ_CHAR *pathName, NQ_UINT *sectorsPerCluster,
                            NQ_UINT *bytesPerSector, NQ_UINT *freeClusters, NQ_UINT *totalClusters,
                            NQ_UINT *fsType, NQ_UINT *serialNumber);

NQ_BOOL ccGetDiskFreeSpace(const NQ_WCHAR *pathName, NQ_UINT *sectorsPerCluster,
                            NQ_UINT *bytesPerSector, NQ_UINT *freeClusters, NQ_UINT *totalClusters,
                            NQ_UINT *fsType, NQ_UINT *serialNumber);

NQ_BOOL ccGetDiskFreeSpaceExA(const NQ_CHAR *pathName, NQ_UINT *sectorsPerCluster,
                            NQ_UINT *bytesPerSector, NQ_UINT64 *freeClusters, NQ_UINT64 *totalClusters,
                            NQ_UINT *fsType, NQ_UINT *serialNumber);

NQ_BOOL ccGetDiskFreeSpaceEx(const NQ_WCHAR *pathName, CCVolumeInfo *volumeInfo);

NQ_UINT32 ccGetFileAttributesA(const NQ_CHAR *fileName);

NQ_BOOL ccGetFileAttributes(const NQ_WCHAR *fileName, NQ_UINT32 *attributes);

NQ_BOOL ccSetFileAttributesA(const NQ_CHAR *fileName, NQ_UINT32 attributes);

NQ_BOOL ccSetFileAttributes(const NQ_WCHAR *fileName, NQ_UINT32 attributes);

NQ_BOOL ccGetFileInformationByNameA(const NQ_CHAR *fileName, FileInfo_t *fileInfo);

NQ_BOOL ccGetFileInformationByName(const NQ_WCHAR *fileName, CCFileInfo *fileInfo);

NQ_BOOL ccSetFileSizeByNameA(const NQ_CHAR *fileName, NQ_UINT32 sizeLow, NQ_UINT32 sizeHigh);

NQ_BOOL ccSetFileSizeByName(const NQ_WCHAR *fileName, NQ_UINT64 size);

NQ_BOOL ccSetFileSizeByHandle(NQ_HANDLE handle, NQ_UINT64 size);

NQ_BOOL ccGetFileTime(NQ_HANDLE handle, CCFileTime *pCreation, CCFileTime *pLastAccess, CCFileTime *pLastWrite);

NQ_BOOL ccSetFileTime(NQ_HANDLE handle, CCFileTime *pCreation, CCFileTime *pLastAccess, CCFileTime *pLastWrite);

NQ_BOOL ccGetFileSize(NQ_HANDLE handle, NQ_UINT64 *fileSize);

NQ_BOOL ccGetFileInformationByHandle(NQ_HANDLE handle, CCFileInfo *fileInfo);

void ccConfigSetTimeout(NQ_UINT32 secs);

NQ_UINT32 ccConfigGetTimeout(void);

#if defined(UD_NQ_USETRANSPORTNETBIOS) || defined(DOXYGEN)

NQ_BOOL ccSetGetBackupListTimeout(NQ_UINT32 seconds);

#endif /* UD_NQ_USETRANSPORTNETBIOS */

#if defined(UD_CC_INCLUDEBROWSING) || defined(DOXYGEN)

#if defined(UD_NQ_USETRANSPORTNETBIOS) || defined(DOXYGEN)

NQ_BOOL ccNetworkSetDefaultDomainA(const NQ_CHAR *domain);

NQ_BOOL ccNetworkSetDefaultDomain(const NQ_WCHAR *domain);

void ccNetworkCacheSet(NQ_UINT32 timeout);

const NQ_CHAR* ccNetworkGetDefaultDomainA();

const NQ_WCHAR* ccNetworkGetDefaultDomain();

NQ_HANDLE ccNetworkEnumerateDomains(void);

CCNetDomainItem * ccNetworkGetNextDomainItem(NQ_HANDLE handle);
#endif /* UD_NQ_USETRANSPORTNETBIOS */

NQ_HANDLE ccNetworkEnumerateServersA(const NQ_CHAR * domain);

NQ_HANDLE ccNetworkEnumerateServers(const NQ_WCHAR * domain);

CCNetServerItem * ccNetworkGetNextServerItem(NQ_HANDLE handle);

NQ_HANDLE ccNetworkEnumerateSharesA(const NQ_CHAR * server);

NQ_HANDLE ccNetworkEnumerateShares(const NQ_WCHAR * server);

const NQ_CHAR * ccNetworkGetNextItemNameA(NQ_HANDLE handle);

const NQ_WCHAR * ccNetworkGetNextItemName(NQ_HANDLE handle);

CCNetShareItem * ccNetworkGetNextShareItem(NQ_HANDLE handle);

NQ_BOOL ccNetworkGetShareInfoA(const NQ_CHAR * server, const NQ_CHAR * share, NQ_UINT16 * type, NQ_CHAR * remarkBuffer, NQ_INT bufferSize);

NQ_BOOL ccNetworkGetShareInfo(const NQ_WCHAR * server, const NQ_WCHAR * share, NQ_UINT16 * type, NQ_WCHAR * remarkBuffer, NQ_INT bufferSize);

NQ_BOOL ccNetworkCloseHandle(NQ_HANDLE handle);

NQ_BOOL ccNetworkResetHandle(NQ_HANDLE handle);

#endif /* UD_CC_INCLUDEBROWSING */

#if defined(UD_CC_INCLUDEDOMAINMEMBERSHIP) || defined(DOXYGEN)

NQ_BOOL ccDomainJoinA(const NQ_CHAR *domain, const NQ_CHAR *computer, const AMCredentialsA *admin, NQ_BYTE secret[16]);

NQ_BOOL ccDomainJoin(const NQ_WCHAR *domain, const NQ_WCHAR *computer, const AMCredentials *admin, NQ_BYTE secret[16]);

NQ_BOOL ccDomainJoinPersistent(const NQ_WCHAR *domain, const NQ_WCHAR *computer, const AMCredentials *admin, const NQ_WCHAR * dns);

NQ_BOOL ccDomainUpdateSecretA(const NQ_CHAR *domain, const NQ_CHAR *computer, const AMCredentialsA *admin, NQ_BYTE secret[16]);

NQ_BOOL ccDomainUpdateSecret(const NQ_WCHAR *domain, const NQ_WCHAR *computer, const AMCredentials *admin, NQ_BYTE secret[16]);

NQ_BOOL ccDomainLeaveA(const NQ_CHAR *domain, const NQ_CHAR *computer, const AMCredentialsA *admin);

NQ_BOOL ccDomainLeave(const NQ_WCHAR *domain, const NQ_WCHAR *computer, const AMCredentials *admin);

NQ_BOOL ccDomainLogonA(const NQ_CHAR * domain, const NQ_CHAR * computer, const AMCredentialsA * admin, NQ_BYTE secret[16]);

NQ_BOOL ccDomainLogon(const NQ_WCHAR *domain, const NQ_WCHAR * computer, const AMCredentials * admin, NQ_BYTE secret[16]);

#endif /* UD_CC_INCLUDEDOMAINMEMBERSHIP */

NQ_BOOL ccGetSigningPolicy(void);

void ccSetSigningPolicy(NQ_BOOL enable);

NQ_STATUS ccSetMinSecurityLevel(NQ_INT level);

NQ_INT ccGetMinSecurityLevel(void);

NQ_STATUS ccSetMaxSecurityLevel(NQ_INT level);

NQ_INT ccGetMaxSecurityLevel(void);

#if defined(UD_CC_INCLUDESECURITYDESCRIPTORS) || defined(DOXYGEN)

NQ_BOOL ccSetExclusiveAccessToFileA(NQ_CHAR *fileName, NQ_BOOL makeExclusive);

NQ_BOOL ccSetExclusiveAccessToFile(NQ_WCHAR *fileName, NQ_BOOL makeExclusive);

NQ_BOOL ccIsExclusiveAccessToFileA(NQ_CHAR *fileName);

NQ_BOOL ccIsExclusiveAccessToFile(NQ_WCHAR *fileName);

#endif /* UD_CC_INCLUDESECURITYDESCRIPTORS */

NQ_BOOL ccSetSmbDialect(CCSmbDialect dialect, NQ_BOOL setActive);

NQ_BOOL ccCifsGetSMB1Support(void);

#if defined(UD_NQ_INCLUDESMB1) || defined(DOXYGEN)

void
ccCifsSetSMB1Support(
        NQ_BOOL isSupport
        );
#endif /* UD_NQ_INCLUDESMB1 */

NQ_BOOL ccResetCredentailsA(const NQ_CHAR * mountpoint);

NQ_BOOL ccResetCredentails(const NQ_WCHAR * mountpoint);

NQ_BOOL ccValidateUserA(NQ_CHAR *server);

NQ_BOOL ccValidateUser(NQ_WCHAR *server);

NQ_BOOL ccValidateUserByCredentialsA(NQ_CHAR * server, const AMCredentialsA * userCredentials);

NQ_BOOL ccValidateUserByCredentials(NQ_WCHAR * server, const AMCredentials * userCredentials);

NQ_UINT32 ccGetNTStatus(void);

NQ_UINT32 ccErrorToSmbStatus(NQ_STATUS nqError);

NQ_BOOL ccTransportRestartRecieveThread();

void ccDump(void);

void ccCloseAllConnections(void);

void ccCloseHiddenConnections(void);

void ccThreadSubscribe(void);

void ccThreadUnsubscribe(void);

#endif /* _CCAPI_H_ */